Clawback

The Clawback API allows users to claw back or recover assets from a specified destination account to the issuer account. This operation is typically used by asset issuers to reclaim or revoke issued assets from specific accounts.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Response Parameters

Parameter	Description
SourceAccount	Object
PublicKey Mandatory	String The public key of the account initiating the clawback operation. Ex: "GCPLZXWATKYY3OXXHDOU3TSIUNZA5ZVBMM6P6ONGZQJHICXSFGFWNBPW"
PrivateKey Mandatory	String The private key associated with the source account for authentication. Ex: ""
sponser	Object
publicKey Mandatory	String The public key of the account acting as the sponsor for the transaction fee. Ex: "GAUMO2B3RA6HRNDEVZUZAV5ZP2YE5V37UZTIFMKKRAH2IK5XDTZBJCZ3"
PrivateKey Mandatory	String The private key associated with the sponsor account for authentication. Ex: ""
IssuerAccount	Object
publicKey Mandatory	String The public key of the account that issued the asset being clawed back. Ex: "GAUMO2B3RA6HRNDEVZUZAV5ZP2YE5V37UZTIFMKKRAH2IK5XDTZBJCZ3"
PrivateKey Mandatory	String The private key associated with the issuer account for authentication. Ex: ""
Asset	Object
Code Mandatory	String The code representing the asset to be clawed back. Ex: "XDUS"
IssuerKey Mandatory	String The public key of the account that issued the asset. Ex: "GAHQYF2BNR5PGXPMWHOPXQA2Y3T2HVBBBF7ON7D2427T7FPZRMIRE6XD"
DestinationAccount	Object
publicKey Mandatory	String The public key of the account from which the assets will be clawed back. Ex: "GAUMO2B3RA6HRNDEVZUZAV5ZP2YE5V37UZTIFMKKRAH2IK5XDTZBJCZ3"
PrivateKey Mandatory	String The private key associated with the destination account for authentication. Ex: ""
Amount Mandatory	Number The quantity of the asset to be clawed back from the destination account. Ex: 1234

Body

{
    "SourceAccount": {
        "PublicKey": "GCPLZXWATKYY3OXXHDOU3TSIUNZA5ZVBMM6P6ONGZQJHICXSFGFWNBPW",
        "PrivateKey": ""
    },
    "sponser": {
        "publicKey": "GAUMO2B3RA6HRNDEVZUZAV5ZP2YE5V37UZTIFMKKRAH2IK5XDTZBJCZ3",
        "PrivateKey": ""
    },
    "IssuerAccount": {
        "publicKey": "GAUMO2B3RA6HRNDEVZUZAV5ZP2YE5V37UZTIFMKKRAH2IK5XDTZBJCZ3",
        "PrivateKey": ""
    },
    "Asset": {
        "Code": "XDUS",
        "IssuerKey": "GAHQYF2BNR5PGXPMWHOPXQA2Y3T2HVBBBF7ON7D2427T7FPZRMIRE6XD"
    },
    "DestinationAccount": {
        "publicKey": "GAUMO2B3RA6HRNDEVZUZAV5ZP2YE5V37UZTIFMKKRAH2IK5XDTZBJCZ3",
        "PrivateKey": ""
    },
    "Amount": 1234
}

Response: 200

Response Parameters

Parameter	Description
hash	String A unique identifier representing the transaction hash of the Clawback operation. Ex: "fbef2e61b8961114a285a8d1ba9c20076f13f636db4fc452dae64bf763390724"

{
    "hash": "fbef2e61b8961114a285a8d1ba9c20076f13f636db4fc452dae64bf763390724"
}